/*
 * Copyright (c) 2011 Anthony Vandikas
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, 
 * modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software 
 * is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

/**
 * Acts as a database of Entries which allows submission
 * of new entries and querying for entries that meet certain criteria.
 */
class AbstractHistory : public QObject
{
	Q_OBJECT

public:
	/**
	 * Virtual destructor to enable inheritance.
	 */
	virtual ~AbstractHistory() = 0;

	/**
	 * Clears the database of all entries.
	 */
	virtual void clear() = 0;

	/**
	 * Records a new entry to the database.
	 * The date/time cannot be specified - it is typically obtained from the current date and time.
	 *
	 * @param student The student who is recording the entry.
	 * @param item The item being signed out.
	 */
	virtual void record(const Student &student, const Item &item) = 0;

	/**
	 * Returns all entries in the database that meet the specified criteria.
	 *
	 * @param minDate The minimum date for the entries to have been entered.
	 * @param maxDate The maximum date for the entries to have been entered.
	 * @param studentKeywords The search terms for the student.
	 * @param itemKeywords The search terms for the item.
	 */
	virtual QList<Entry> filter(const QDate &minDate, const QDate &maxDate, const QStringList &studentKeywords, const QStringList &itemKeywords) = 0;

signals:
	/**
	 * This signal is emitted when the database is modified, e.g. when a new entry is recorded.
	 */
	void modified() const;
};
